Transfer Order API - Asset

Version 1.0 — May 2024

To access the GraphQL APIs, users must first authenticate using the Xemelgo Login REST API.

Endpoint Details

URL: https://rest.api.xemelgo.com/login
Method: POST

Properties

Property	Type	Description	Required
`email`	String	base64 Encoded email id for user	Yes
`password`	String	base64 encoded password for user	Yes

Password needs to be a minimum of 8 characters and should have a number in it.

Request Body

{
  "email": "base64_encoded_email",
  "password": "base64_encoded_password"
}

StatusCode - 200 on success

Response Body

{
  "AccessToken": "$accessToken",
  "ExpiresIn": 480,
  "TokenType": "Bearer",
  "RefreshToken": "$refreshToken",
  "IdToken": "$idToken"
}

Use the $idToken as the authorization header for all API requests.

Errors

Error	Error code	Exception
In correct username and/or password	400	NotAuthorizedException

Create Asset Transfer Order API

Create Asset Transfer Order API allows to create the transfer order and keep track of the items associated with the transfer order.

Endpoint Details

URL: https://api.xemelgo.com/graphql
Method: POST

Properties

Property	Type	Description	Required
`id`	String	Transfer order number	Yes
`transferFromId`	String	Source location	No
`transferToId`	String	Destination location	No
`entries`	Array	List of assets and their quantities (view table below)	Yes
`customProperties`	AWSJSON	Additional properties applicable to transfer orders	No

entries

Property	Type	Description	Required
`assetId`	String	Asset identifier	Yes
`totalQuantity`	Number	Quantity of the asset	Yes
`trackerSerials`	Array of String	List of EPCs for the asset as part of the transfer order	No
`unit`	String	Unit of measure (if applicable)	No

Headers

Authorization – $idToken

Request Body

mutation createAssetTransferOrder {
  createAssetTransferOrder(
    input: CreateAssetTransferOrderInput!
  ) {
    assetTransferOrder {
      cancelledDate
      creationDate
      id
      receiveDate
      startDate
      transferFrom {
        customProperties
        description
        id
        name
      }
      status
      lastUpdatedDate
      entries {
        lastUpdatedDate
        asset {
          customProperties
          description
          name
          id
        }
        inventory {
          trackerSerial
          id
          name
          description
        }
        inTransitQuantity
        receivedQuantity
        unit
        totalQuantity
      }
      transferTo {
        customProperties
        description
        id
        name
      }
    }
  }
}
----------------------------------------------------------------------

CreateAssetTransferOrderInput {
  transferFromId: "Location A",
  transferToId: "Location B",
  entries: [
    {
      assetId: "Asset-123",
      totalQuantity: 3,
      trackerSerials: ["EPC1", "EPC2", "EPC3"],
      unit: "EA"
    }
  ],
  id: "TEST_ASSET_TRANSFER_ORDER"
}

Status Code - 200

Response Body

AssetTransferOrder {
  id: String
  status: TransferOrderStatus
  transferFrom: LocationV2
  transferTo: LocationV2
  creationDate: AWSTimestamp
  startDate: AWSTimestamp
  completedDate: AWSTimestamp
  cancelledDate: AWSTimestamp
  entries: [AssetTransferOrderEntry!]!
  lastUpdatedDate: AWSTimestamp
  customProperties: AWSJSON
}

Errors

Error	Error code	Exception
`Expired token`	401	Unauthorized
`Invalid token`	401	Unauthorized
`Missing Authorization Header`	401	Unauthorized

Error Response Examples

Expired Token

{
  "errors": [
    {
      "errorType": "UnauthorizedException",
      "message": "Token has expired."
    }
  ]
}

Invalid token

{
  "errors": [
    {
      "errorType": "UnauthorizedException",
      "message": "Unable to parse JWT token"
    }
  ]
}

Missing Authorization Header

{
  "errors": [
    {
      "errorType": "UnauthorizedException",
      "message": "User is not authorized to make this call."
    }
  ]
}

Additional 200-Level Errors

Error	Error description	Error code
`ValidationError`	No id provided, no entries, quantity ≤ 0, no asset, duplicate asset	200
`ResourceNotFoundError`	Tracker serial does not exist	200
`UnexpectedError`	Some unexpected things happened on create, duplicate locations with the same identifier	200
`LocationNotFoundError`	From/to location not found	200
`ResourceAlreadyExistError`	Transfer order with this identifier already exists	200

Get Transfer Order API

Get Transfer Order API allows to retrieve the transfer order and view its status.

Endpoint Details

URL: https://api.xemelgo.com/graphql
Method: POST

Properties

Property	Type	Description	Required
`id`	String	Transfer order number	Yes

Headers

Authorization – $idToken

Request Body

query assetTransferOrder($id: String) {
  assetTransferOrder(input: { id: $id }) {
    assetTransferOrder {
      cancelledDate
      creationDate
      id
      receivedDate
      startDate
      transferFrom {
        customProperties
        description
        id
        name
      }
      status
      lastUpdatedDate
      entries {
        lastUpdatedDate
        asset {
          customProperties
          description
          id
          name
        }
        inventory {
          trackerSerial
          id
          name
          description
        }
        inTransitQuantity
        receivedQuantity
        unit
        totalQuantity
      }
      transferTo {
        customProperties
        description
        id
        name
      }
    }
  }
}

Status Code - 200

Response Body

AssetTransferOrder {
  id: String
  status: TransferOrderStatus
  transferFrom: LocationV2
  transferTo: LocationV2
  creationDate: AWSTimestamp
  startDate: AWSTimestamp
  completedDate: AWSTimestamp
  cancelledDate: AWSTimestamp
  entries: [AssetTransferOrderEntry!]!
  lastUpdatedDate: AWSTimestamp
  customProperties: AWSJSON
}

Errors

Error	Error code	Exception
`Expired token`	401	Unauthorized
`Invalid token`	401	Unauthorized
`Missing Authorization Header`	401	Unauthorized

Error Response Examples

Expired Token

{
  "errors": [
    {
      "errorType": "UnauthorizedException",
      "message": "Token has expired."
    }
  ]
}

Invalid token

{
  "errors": [
    {
      "errorType": "UnauthorizedException",
      "message": "Unable to parse JWT token"
    }
  ]
}

Missing Authorization Header

{
  "errors": [
    {
      "errorType": "UnauthorizedException",
      "message": "User is not authorized to make this call."
    }
  ]
}

Additional 200-Level Errors

Error	Error description	Error code
`ValidationError`	No id provided	200
`ResourceNotFoundError`	Transfer order not found	200

List Transfer Orders API

List Transfer Orders API allows to retrieve all the transfer orders and view their statuses.

Endpoint Details

URL: https://api.xemelgo.com/graphql
Method: POST

Properties

Property	Type	Description	Required
`filter`	String	Filter for transfer order properties	No
`nextToken`	String	Pagination support	No

Headers

Authorization – $idToken

Request Body

query assetTransferOrders($filter: String, $nextToken: String) {
  assetTransferOrders(input: { filter: $filter, nextToken: $nextToken }) {
    assetTransferOrders {
      cancelledDate
      creationDate
      id
      receivedDate
      startDate
      transferFrom {
        customProperties
        description
        id
        name
      }
      status
      lastUpdatedDate
      entries {
        lastUpdatedDate
        asset {
          customProperties
          description
          id
          name
        }
        inventory {
          trackerSerial
          id
          name
          description
        }
        inTransitQuantity
        receivedQuantity
        unit
        totalQuantity
      }
      transferTo {
        customProperties
        description
        id
        name
      }
    }
  }
}

Status Code - 200

Response Body

AssetTransferOrder {
  id: String
  status: TransferOrderStatus
  transferFrom: LocationV2
  transferTo: LocationV2
  creationDate: AWSTimestamp
  startDate: AWSTimestamp
  completedDate: AWSTimestamp
  cancelledDate: AWSTimestamp
  entries: [AssetTransferOrderEntry]!
  lastUpdatedDate: AWSTimestamp
  customProperties: AWSJSON
}

Errors

Error	Error code	Exception
`Expired token`	401	Unauthorized
`Invalid token`	401	Unauthorized
`Missing Authorization Header`	401	Unauthorized

Error Response Examples

Expired Token

{
  "errors": [
    {
      "errorType": "UnauthorizedException",
      "message": "Token has expired."
    }
  ]
}

Invalid token

{
  "errors": [
    {
      "errorType": "UnauthorizedException",
      "message": "Unable to parse JWT token"
    }
  ]
}

Missing Authorization Header

{
  "errors": [
    {
      "errorType": "UnauthorizedException",
      "message": "User is not authorized to make this call."
    }
  ]
}

Delete Transfer Order API

Delete Transfer Order API allows to remove the transfer order.

Endpoint Details

URL: https://api.xemelgo.com/graphql
Method: POST

Properties

Property	Type	Description	Required
id	String	Transfer order number	Yes

Headers

Authorization – $idToken

Request Body

mutation deleteAssetTransferOrder {
  deleteAssetTransferOrder(input: { id: "TEST_ASSET_TRANSFER_ORDER" }) {
    assetTransferOrder {
      cancelledDate
      creationDate
      id
      receivedDate
      startDate
      transferFrom {
        customProperties
        description
        id
        name
      }
      status
      lastUpdatedDate
      entries {
        lastUpdatedDate
        asset {
          customProperties
          description
          id
          name
        }
        inventory {
          trackerSerial
          id
          name
          description
        }
        inTransitQuantity
        receivedQuantity
        unit
        totalQuantity
      }
      transferTo {
        customProperties
        description
        id
        name
      }
    }
  }
}

Status Code - 200

Response Body

AssetTransferOrder {
  id: String
  status: TransferOrderStatus
  transferFrom: LocationV2
  transferTo: LocationV2
  creationDate: AWSTimestamp
  startDate: AWSTimestamp
  completedDate: AWSTimestamp
  cancelledDate: AWSTimestamp
  entries: [AssetTransferOrderEntry!]!
  lastUpdatedDate: AWSTimestamp
  customProperties: AWSJSON
}

Errors

Error	Error code	Exception
`Expired token`	401	Unauthorized
`Invalid token`	401	Unauthorized
`Missing Authorization Header`	401	Unauthorized

Error Response Examples

Expired Token

{
  "errors": [
    {
      "errorType": "UnauthorizedException",
      "message": "Token has expired."
    }
  ]
}

Invalid token

{
  "errors": [
    {
      "errorType": "UnauthorizedException",
      "message": "Unable to parse JWT token"
    }
  ]
}

Missing Authorization Header

{
  "errors": [
    {
      "errorType": "UnauthorizedException",
      "message": "User is not authorized to make this call."
    }
  ]
}

Additional 200-Level Errors

Error	Error description	Error code
ValidationError	No id provided	200
ResourceNotFoundError	Transfer order not found	200

Transfer Order API - Asset

Version 1.0 — May 2024

Authentication - Login API​

Endpoint Details​

Properties​

Request Body​

Response Body​

Errors​

Create Asset Transfer Order API​

Endpoint Details​

Properties​

entries​

Headers

Request Body​

Response Body​

Errors​

Error Response Examples​

Expired Token​

Invalid token​

Missing Authorization Header​

Additional 200-Level Errors​

Get Transfer Order API​

Endpoint Details​

Properties​

Headers

Request Body​

Response Body​

Errors​

Error Response Examples​

Expired Token​

Invalid token​

Missing Authorization Header​

Additional 200-Level Errors​

List Transfer Orders API​

Endpoint Details​

Properties​

Headers

Request Body​

Response Body​

Errors​

Error Response Examples​

Expired Token​

Invalid token​

Missing Authorization Header​

Delete Transfer Order API​

Endpoint Details​

Properties​

Headers

Request Body​

Response Body​

Errors​

Error Response Examples​

Expired Token​

Invalid token​

Missing Authorization Header​

Additional 200-Level Errors​

Authentication - Login API

Endpoint Details

Properties

Request Body

Response Body

Errors

Create Asset Transfer Order API

Endpoint Details

Properties

entries

Request Body

Response Body

Errors

Error Response Examples

Expired Token

Invalid token

Missing Authorization Header

Additional 200-Level Errors

Get Transfer Order API

Endpoint Details

Properties

Request Body

Response Body

Errors

Error Response Examples

Expired Token

Invalid token

Missing Authorization Header

Additional 200-Level Errors

List Transfer Orders API

Endpoint Details

Properties

Request Body

Response Body

Errors

Error Response Examples

Expired Token

Invalid token

Missing Authorization Header

Delete Transfer Order API

Endpoint Details

Properties

Request Body

Response Body

Errors

Error Response Examples

Expired Token

Invalid token

Missing Authorization Header

Additional 200-Level Errors